The GiddyUp Developer Documentation provides details on how to utilize Custom Application API endpoints to manage your data within the GiddyUp platform.
\nTo utilize the API endpoints, you will need to set your Authorization header in the requests. The header is set to a value similar to Token 0your1token2here3. You can retrieve your API token from your custom app settings within the GiddyUp platform. The Token will be available on your Custom Application Integration settings page, in the API section under API Authentication Key.
To utilize this postman collection, you will first need to set some variables on the collection. To do this, click Variables above to open the variables page. Set the following variables.
\ntoken : The Authorization token described above.
order_id : An order ID from your Order dashboard to test with. This will look something like SAMPLE-1234
This endpoint is used to get details about a specific order.
\nid (string): The ID of the order.
aff_id (int, nullable): Affiliate ID for the order.
customer_first_name (string): The first name of the customer.
customer_last_name (string): The last name of the customer.
shipping_address_line1 (string): The first line of the shipping address.
shipping_address_line2 (string): The second line of the shipping address.
shipping_city (string): The city for shipping.
shipping_region (string): The region for shipping.
shipping_country (string): The country for shipping.
shipping_postal_code (string): The postal code for shipping.
customer_phone (string): The phone number of the customer.
customer_email (string): The email address of the customer.
status (string): Possible values: placed, cancelled
ordered_at (string): The date and time when the order was placed.
total (string): The total amount of the order.
discount_total (string): The total amount discounted in the order.
subtotal (string): The subtotal amount of the order.
tax (string): The tax amount of the order.
shipping_cost (string): The shipping cost of the order.
shipping_cost_tax (string): The shipping cost tax of the order.
items (array): An array of objects containing details of items in the order, including ID, name, quantity, price, subtotal, tax amount, tax details, sub-items and discounts.
discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
returns (array): An array of objects containing details of items being returned, including item_id, child_item_id, quantity, and reason.
refunds (array): An array of objects containing details of refunds, including ID,, amount, shipping_amount, status, reason, and created_at.
shipments (array): An array of objects containing details of shipments, including reference ID (reference ID for this order in fulfillment provider), shipment status (not_shipped, shipped, cancelled), tracking number, tracking URL and carrier name.
currency (string): The currency used for the order.
vat_inclusive (boolean): Indicates if VAT is inclusive.
currency_format (object): Details of the currency formatting to use with the customer's currency. The currency format contains:
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
currency_conversions (array): An array of objects containing details of currency conversions, including currency and rate.
This endpoint is used to initiate a return for a specific order.
\nreturn_items (array, required): An array of objects containing the following fields:
reason (string, required): The reason for the refund. Return reasons are specified in your Brand settings in the GiddyUp platform and can be individually enabled or disabled. Your specific list of reasons can be found on your Settings page and clicking on Support and Returns. It's also possible to use the Get Return Reasons request in this collection to get your specific allowed reasons. Commonly used reasons are:
didnt_see_results
discomfort_using
item_didnt_fit
product_defective
product_not_as_described
product_wrong_item_received
shipping_order_issue
other
quantity (number, required): The quantity of the item being returned.
id (number, required): The id of the item being returned
child_item_id (number, optional): the id of the child item being returned. This field should be removed completely if it's unused.
id (string): The ID of the order.
aff_id (int, nullable): Affiliate ID for the order.
customer_first_name (string): The first name of the customer.
customer_last_name (string): The last name of the customer.
shipping_address_line1 (string): The first line of the shipping address.
shipping_address_line2 (string): The second line of the shipping address.
shipping_city (string): The city for shipping.
shipping_region (string): The region for shipping.
shipping_country (string): The country for shipping.
shipping_postal_code (string): The postal code for shipping.
customer_phone (string): The phone number of the customer.
customer_email (string): The email address of the customer.
status (string): The status of the order.
ordered_at (string): The date and time when the order was placed.
total (string): The total amount of the order.
discount_total (string): The total amount discounted in the order.
subtotal (string): The subtotal amount of the order.
tax (string): The tax amount of the order.
shipping_cost (string): The shipping cost of the order.
items (array): An array of objects containing details of items in the order, including ID, name, quantity, price, subtotal and discounts.
discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
returns (array): An array of objects containing details of items being returned, including item_id, child_item_id, quantity, and reason.
refunds (array): An array of objects containing details of refunds, including ID, transaction_id, amount, shipping_amount, status, reason, and created_at.
currency (string): The currency used for the order.
vat_inclusive (boolean): Indicates if VAT is inclusive.
currency_format (object): Details of the currency formatting to use with the customer's currency. The currency format contains:
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
currency_conversions (array): An array of objects containing details of currency conversions, including currency and rate.
This endpoint is used to initiate a refund for a specific order.
\nreason (string, required): The reason for the refund. Reason can be one of the following:
cancel_backorder
cancel_placed_in_error
payment_unrecognized_charge
product_defective
product_not_as_described
shipping_customs_issue
shipping_delivery_exception
shipping_lost_in_transit
shipping_product_not_received
provider_initiated
transaction_disputed
other
custom_reason (str, 64 characters max): Reason for the refund. Field is required if specified reason is other.
amount (float): The amount to refund on order
shipping_amount (number): The amount to be refunded for shipping.
refund_items (array): An array of objects containing details of items to be refunded, including amount, quantity, and item_id.
id (string): The ID of the order.
aff_id (int, nullable): Affiliate ID for the order.
customer_first_name (string): The first name of the customer.
customer_last_name (string): The last name of the customer.
shipping_address_line1 (string): The first line of the shipping address.
shipping_address_line2 (string): The second line of the shipping address.
shipping_city (string): The city for shipping.
shipping_region (string): The region for shipping.
shipping_country (string): The country for shipping.
shipping_postal_code (string): The postal code for shipping.
customer_phone (string): The phone number of the customer.
customer_email (string): The email address of the customer.
status (string): The status of the order.
ordered_at (string): The date and time when the order was placed.
total (string): The total amount of the order.
discount_total (string): The total amount discounted in the order.
subtotal (string): The subtotal amount of the order.
tax (string): The tax amount of the order.
shipping_cost (string): The shipping cost of the order.
items (array): An array of objects containing details of items in the order, including ID, name, quantity, price, subtotal and discounts.
discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
returns (array): An array of objects containing details of items being returned, including item_id, child_item_id, quantity, and reason.
refunds (array): An array of objects containing details of refunds, including ID, transaction_id, amount, shipping_amount, status, reason, and created_at.
shipments (array): An array of objects containing details of shipments, including reference ID (reference ID for this order in fulfillment provider), shipment status (not_shipped, shipped, cancelled), tracking number, tracking URL and carrier name.
currency (string): The currency used for the order.
vat_inclusive (boolean): Indicates if VAT is inclusive.
currency_format (object): Details of the currency formatting to use with the customer's currency. The currency format contains:
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
currency_conversions (array): An array of objects containing details of currency conversions, including currency and rate.
This endpoint is used to cancel a specific order.
\nreason (string, required): The reason for the refund. Reason can be one of the following:
cancel_backorder
cancel_placed_in_error
payments_unrecognized_charge
product_defective
product_not_as_described
shipping_customs_issue
shipping_delivery_exception
shipping_lost_in_transit
shipping_product_not_received
id (string): The ID of the order.
aff_id (int, nullable): Affiliate ID for the order.
customer_first_name (string): The first name of the customer.
customer_last_name (string): The last name of the customer.
shipping_address_line1 (string): The first line of the shipping address.
shipping_address_line2 (string): The second line of the shipping address.
shipping_city (string): The city for shipping.
shipping_region (string): The region for shipping.
shipping_country (string): The country for shipping.
shipping_postal_code (string): The postal code for shipping.
customer_phone (string): The phone number of the customer.
customer_email (string): The email address of the customer.
status (string): The status of the order.
ordered_at (string): The date and time when the order was placed.
total (string): The total amount of the order.
discount_total (string): The total amount discounted in the order.
subtotal (string): The subtotal amount of the order.
tax (string): The tax amount of the order.
shipping_cost (string): The shipping cost of the order.
items (array): An array of objects containing details of items in the order, including ID, name, quantity, price, subtotal and discounts.
discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
returns (array): An array of objects containing details of items being returned, including item_id, child_item_id, quantity, and reason.
refunds (array): An array of objects containing details of refunds, including ID, transaction_id, amount, shipping_amount, status, reason, and created_at.
currency (string): The currency used for the order.
vat_inclusive (boolean): Indicates if VAT is inclusive.
currency_format (object): Details of the currency formatting to use with the customer's currency. The currency format contains:
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
currency_conversions (array): An array of objects containing details of currency conversions, including currency and rate.
This endpoint is used to get allowed return reasons for a specific brand.
\nTo call this endpoint, you will need to configure your Brand ID variable in the postman collection. Click on the Collection GiddyUp Custom Apps Integration and click the Variables tab. The Brand ID value can be found in the Custom Application Intergration settings page in the GiddyUp platform. This will be a numeric value. Set the brand_id variable in the Postman collection to this value.
X-Brand-ID : The brand ID of the brand you're looking up return reasons for. This value can be found in the Custom Application Integration settings page. It will be a number value.
count (number): The total number of return reasons specified for the brandnext (string): The link to call to get the next page of resultsprevious (string): The link to call to get the previous page of resultsresults (array): An array of return reasons with fields:id (number): The ID of the return reasonreason (string): The return reason which is allowed for the brand. This value can be used for the Create Return API call.brand (number): The brand IDvisible_to_shopper (boolean): Whether the return reason is visible to the shopper when they initiate a return.display_order (number): The index this return reason is displayed at within a list.The Orders endpoints can be used to manage your orders within the GiddyUp platform.
\n","_postman_id":"b08b4499-b498-4f9d-be09-f014d0e1e2f5"},{"name":"Webhooks","item":[{"name":"Order Placed","id":"447413a3-98a3-46ce-b7c0-cb01608b0a17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-giddyup-hmac-sha256","value":"sha256abc123","description":"HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"order.placed\",\n \"user\": null,\n \"order\": {\n \"id\": \"TEST-20825\",\n \"aff_id\": 112211,\n \"customer_first_name\": \"John\",\n \"customer_last_name\": \"Doe\",\n \"shipping_address_line1\": \"200 North Spring Street\",\n \"shipping_address_line2\": null,\n \"shipping_city\": \"Los Angeles\",\n \"shipping_region\": \"CA\",\n \"shipping_country\": \"US\",\n \"shipping_postal_code\": \"90012\",\n \"customer_phone\": \"16501234567\",\n \"customer_email\": \"john.doe@example.com\",\n \"status\": \"placed\",\n \"ordered_at\": \"2024-04-29T21:06:38.497723Z\",\n \"total\": \"104.13\",\n \"discount_total\": \"9.99\",\n \"subtotal\": \"85.97\",\n \"tax\": \"8.16\",\n \"shipping_cost\": \"10.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"items\": [\n {\n \"id\": 36206,\n \"name\": \"Buy 2, Get 1 FREE\",\n \"quantity\": 1,\n \"price\": \"85.97\",\n \"subtotal\": \"85.97\",\n \"tax\": \"8.16\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"items\": [\n {\n \"id\": 34485,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34486,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34487,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n }\n ],\n \"tax_details\": [\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"0.86\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"shipments\": [],\n \"currency\": \"USD\",\n \"vat_inclusive\": false,\n \"currency_format\": {\n \"decimal_mark\": \".\",\n \"thousands_separator\": \",\",\n \"prefix\": \"$\",\n \"suffix\": \"\",\n \"currency_code_suffix\": \"\",\n \"format\": \"$[amount]\"\n },\n \"currency_conversions\": [\n {\n \"currency\": \"USD\",\n \"rate\": \"1.000000000000000\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an order placed event payload to the specified webhook URL. The request body will be in json format and include an event type along with order details such as ID, customer information, shipping details, order status, pricing, items, returns, refunds, currency, VAT information, and currency conversions.
\nevent_type (string): Type of event associated with the order. This will be order.placed for an order placed event.
user (string): Email address of the brand user who performed this action. This will be null for an order placed event, as order is placed by customer and not initiated by brand user.
order.id (string): Unique identifier for the order.
order.aff_id (int, nullable): Affiliate ID for the order.
order.customer_first_name (string): First name of the customer.
order.customer_last_name (string): Last name of the customer.
order.shipping_address_line1 (string): First line of the shipping address.
order.shipping_address_line2 (string): Second line of the shipping address.
order.shipping_city (string): City for shipping address.
order.shipping_region (string): Region for shipping address.
order.shipping_country (string): Country for shipping address.
order.shipping_postal_code (string): Postal code for shipping address.
order.customer_phone (string): Phone number of the customer.
order.customer_email (string): Email address of the customer.
order.status (string): Status of the order.
order.ordered_at (string): Date and time when the order was placed.
order.total (string): Total amount for the order.
order.discount_total (string): The total amount discounted in the order.
order.subtotal (string): Subtotal amount for the order.
order.tax (string): Tax amount for the order.
order.shipping_cost (string): Shipping cost for the order.
order.shipping_cost_tax (string): Shipping cost tax for the order.
order.items (array): Array of items included in the order, each containing ID, name, quantity, price, subtotal, tax amount, tax details, sub-items and discounts.
order.discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
order.returns (array): Array of returned items.
order.refunds (array): Array of refunded items.
order.shipments (array): Array of order shipments.
order.currency (string): Currency used for the order.
order.vat_inclusive (boolean): Indicates if VAT is inclusive in the pricing.
order.currency_format (object): Format details for the currency including decimal mark, thousands separator, prefix, suffix, currency code suffix, and format.
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
order.currency_conversions (array): Array of currency conversions with currency and rate.
The response to this request can be any value with a success response code (i.e. 2xx)
HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"order.cancelled\",\n \"user\": \"john.doe@example.com\",\n \"order\": {\n \"id\": \"TEST-20825\",\n \"aff_id\": null,\n \"customer_first_name\": \"John\",\n \"customer_last_name\": \"Doe\",\n \"shipping_address_line1\": \"200 North Spring Street\",\n \"shipping_address_line2\": \"\",\n \"shipping_city\": \"Los Angeles\",\n \"shipping_region\": \"CA\",\n \"shipping_country\": \"US\",\n \"shipping_postal_code\": \"90012\",\n \"customer_phone\": \"+1 (000) 123-4567\",\n \"customer_email\": \"john.doe@example.com\",\n \"status\": \"cancelled\",\n \"ordered_at\": \"2024-04-29T21:06:38.497723Z\",\n \"total\": \"104.13\",\n \"discount_total\": \"9.99\",\n \"subtotal\": \"85.97\",\n \"tax\": \"8.16\",\n \"shipping_cost\": \"10.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"items\": [\n {\n \"id\": 36206,\n \"name\": \"Buy 2, Get 1 FREE\",\n \"quantity\": 1,\n \"price\": \"85.97\",\n \"subtotal\": \"85.97\",\n \"tax\": \"8.16\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"items\": [\n {\n \"id\": 34485,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34486,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34487,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n }\n ],\n \"tax_details\": [\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"0.86\"\n },\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"-5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"-0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"-1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"-0.86\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"returns\": [],\n \"refunds\": [\n {\n \"id\": 2890,\n \"transaction_id\": 26037,\n \"amount\": \"104.13\",\n \"shipping_amount\": \"10.00\",\n \"status\": \"new\",\n \"reason\": \"cancel_placed_in_error\",\n \"created_at\": \"2024-04-29T21:20:41.556214Z\"\n }\n ],\n \"shipments\": [\n {\n \"reference_id\": \"TEST-20825\",\n \"status\": \"canceled\",\n \"tracking_number\": null,\n \"tracking_url\": null,\n \"carrier_name\": null\n }\n ],\n \"currency\": \"USD\",\n \"vat_inclusive\": false,\n \"currency_format\": {\n \"decimal_mark\": \".\",\n \"thousands_separator\": \",\",\n \"prefix\": \"$\",\n \"suffix\": \"\",\n \"currency_code_suffix\": \"\",\n \"format\": \"$[amount]\"\n },\n \"currency_conversions\": [\n {\n \"currency\": \"USD\",\n \"rate\": \"1.000000000000000\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an order cancelled event payload to the specified webhook URL. The request body will be in json format and include an event type along with order details such as ID, customer information, shipping details, order status, pricing, items, returns, refunds, currency, VAT information, and currency conversions.
\nevent_type (string): Type of event associated with the order. This will be order.cancelled for an order cancelled event.
user (string): Email address of the brand user who performed this action (cancelled the order).
order.id (string): Unique identifier for the order.
order.aff_id (int, nullable): Affiliate ID for the order.
order.customer_first_name (string): First name of the customer.
order.customer_last_name (string): Last name of the customer.
order.shipping_address_line1 (string): First line of the shipping address.
order.shipping_address_line2 (string): Second line of the shipping address.
order.shipping_city (string): City for shipping address.
order.shipping_region (string): Region for shipping address.
order.shipping_country (string): Country for shipping address.
order.shipping_postal_code (string): Postal code for shipping address.
order.customer_phone (string): Phone number of the customer.
order.customer_email (string): Email address of the customer.
order.status (string): Status of the order.
order.ordered_at (string): Date and time when the order was placed.
order.total (string): Total amount for the order.
order.discount_total (string): The total amount discounted in the order.
order.subtotal (string): Subtotal amount for the order.
order.tax (string): Tax amount for the order.
order.shipping_cost (string): Shipping cost for the order.
order.shipping_cost_tax (string): Shipping cost tax for the order.
order.items (array): Array of items included in the order, each containing ID, name, quantity, price, subtotal, tax amount, tax details, sub-items and discounts.
order.discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
order.returns (array): Array of returned items.
order.refunds (array): Array of refunded items.
order.shipments (array): Array of order shipments.
order.currency (string): Currency used for the order.
order.vat_inclusive (boolean): Indicates if VAT is inclusive in the pricing.
decimal_mark (string): The character used as the decimal mark for the currency.
```\n```\n```\n```\n```\n```\n```\n```\n```\n- `thousands_separator` (string): The character used to separate thousands for the currency.\n- `prefix` (string): The symbol (if applicable) that comes before the amount.\n- `suffix` (string): The symbol (if applicable) that comes after the amount.\n- `currency_code_suffix` (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.\n- `format` (string): The final format for the currency including prefixes and suffixes.\n ```\n ```\n ```\n ```\n ```\n ```\n ```\n ```\n\n ```\norder.currency_conversions (array): Array of currency conversions with currency and rate.
refunds (array): Array of refund objects. When an order is cancelled there will be at least one refund. The refund reason can be one of:
cancel_backorder
cancel_placed_in_error
payment_unrecognized_charge
product_defective
product_not_as_described
shipping_customs_issue
shipping_delivery_exception
shipping_lost_in_transit
shipping_product_not_received
provider_initiated
transaction_disputed
The response to this request can be any value with a success response code (i.e. 2xx)
HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"order.modified\",\n \"user\": \"john.doe@example.com\",\n \"order\": {\n \"id\": \"TEST-20825\",\n \"customer_first_name\": \"John\",\n \"customer_last_name\": \"Doe\",\n \"shipping_address_line1\": \"200 North Spring Street\",\n \"shipping_address_line2\": \"\",\n \"shipping_city\": \"Los Angeles\",\n \"shipping_region\": \"CA\",\n \"shipping_country\": \"US\",\n \"shipping_postal_code\": \"90012\",\n \"customer_phone\": \"+1 (000) 123-4567\",\n \"customer_email\": \"john.doe@example.com\",\n \"status\": \"placed\",\n \"ordered_at\": \"2024-04-29T21:06:38.497723Z\",\n \"total\": \"104.13\",\n \"discount_total\": \"9.99\",\n \"subtotal\": \"85.97\",\n \"tax\": \"8.16\",\n \"shipping_cost\": \"10.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"items\": [\n {\n \"id\": 36206,\n \"name\": \"Buy 2, Get 1 FREE\",\n \"quantity\": 1,\n \"price\": \"85.97\",\n \"subtotal\": \"85.97\",\n \"tax\": \"8.16\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"items\": [\n {\n \"id\": 34485,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34486,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34487,\n \"name\": \"Sample Widget\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"subtotal\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n }\n ],\n \"tax_details\": [\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"0.86\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"shipments\": [\n {\n \"reference_id\": \"TEST-20825\",\n \"status\": \"not_shipped\",\n \"tracking_number\": null,\n \"tracking_url\": null,\n \"carrier_name\": null\n }\n ],\n \"currency\": \"USD\",\n \"vat_inclusive\": false,\n \"currency_format\": {\n \"decimal_mark\": \".\",\n \"thousands_separator\": \",\",\n \"prefix\": \"$\",\n \"suffix\": \"\",\n \"currency_code_suffix\": \"\",\n \"format\": \"$[amount]\"\n },\n \"currency_conversions\": [\n {\n \"currency\": \"USD\",\n \"rate\": \"1.000000000000000\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an order modified event payload to the specified webhook URL. The request body will be in json format and include an event type along with order details such as ID, customer information, shipping details, order status, pricing, items, returns, refunds, currency, VAT information, and currency conversions.
\nevent_type (string): Type of event associated with the order. This will be order.modified for an order modified event.
user (string): Email address of the brand user who performed this action (issued refund, cancelled order item, created order return, marked order return items as received etc).
order.id (string): Unique identifier for the order.
order.aff_id (int, nullable): Affiliate ID for the order.
order.customer_first_name (string): First name of the customer.
order.customer_last_name (string): Last name of the customer.
order.shipping_address_line1 (string): First line of the shipping address.
order.shipping_address_line2 (string): Second line of the shipping address.
order.shipping_city (string): City for shipping address.
order.shipping_region (string): Region for shipping address.
order.shipping_country (string): Country for shipping address.
order.shipping_postal_code (string): Postal code for shipping address.
order.customer_phone (string): Phone number of the customer.
order.customer_email (string): Email address of the customer.
order.status (string): Status of the order.
order.ordered_at (string): Date and time when the order was placed.
order.total (string): Total amount for the order.
order.discount_total (string): The total amount discounted in the order.
order.subtotal (string): Subtotal amount for the order.
order.tax (string): Tax amount for the order.
order.shipping_cost (string): Shipping cost for the order.
order.shipping_cost_tax (string): Shipping cost tax for the order.
order.items (array): Array of items included in the order, each containing ID, name, quantity, price, subtotal, tax amount, tax details, sub-items and discounts.
order.discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
order.returns (array): Array of returned items.
order.refunds (array): Array of refunded items.
order.shipments (array): Array of order shipments.
order.currency (string): Currency used for the order.
order.vat_inclusive (boolean): Indicates if VAT is inclusive in the pricing.
decimal_mark (string): The character used as the decimal mark for the currency.
```\n```\n```\n```\n```\n```\n```\n```\n```\n```\n```\n- `thousands_separator` (string): The character used to separate thousands for the currency.\n- `prefix` (string): The symbol (if applicable) that comes before the amount.\n- `suffix` (string): The symbol (if applicable) that comes after the amount.\n- `currency_code_suffix` (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.\n- `format` (string): The final format for the currency including prefixes and suffixes.\n ```\n ```\n ```\n ```\n ```\n ```\n ```\n ```\n ```\n ```\n\n ```\norder.currency_conversions (array): Array of currency conversions with currency and rate.
refunds (array): Array of refund objects. When an order is cancelled there will be at least one refund. The refund reason can be one of:
cancel_backorder
cancel_placed_in_error
payment_unrecognized_charge
product_defective
product_not_as_described
shipping_customs_issue
shipping_delivery_exception
shipping_lost_in_transit
shipping_product_not_received
provider_initiated
transaction_disputed
The response to this request can be any value with a success response code (i.e. 2xx)
Webhooks can be configured to retrieve events about your orders in the Giddyup platform.
\nTo ensure the security and integrity of data received through webhooks, it's crucial to validate the webhook response. This can be achieved by utilizing the x-giddyup-hmac-sha256 header present in the webhook. This header contains a hash value generated using HMAC SHA-256, based on the webhook content. To validate the webhook, follow these steps:
Retrieve the x-giddyup-hmac-sha256 Header: Extract the x-giddyup-hmac-sha256 header value from the incoming webhook request. This header represents the HMAC SHA-256 encoded signature of the webhook payload.
Generate Your Signature: Compute your own HMAC SHA-256 signature using the webhook payload and your client secret key (Available in the \"API\" section in the Custom Integration section in the GiddyUp platform). Ensure that you're processing the raw body of the webhook payload accurately to match the hashing method used when the signature was created.
\nCompare Signatures: Compare the signature you generated with the x-giddyup-hmac-sha256 value from the webhook's header. If the signatures match, the webhook is validated as authentic and has not been tampered with during transmission. If they don't match, the webhook should be rejected as it may indicate tampering or an issue in the signature generation process.
Validating webhook responses in this manner ensures that the data received is from the expected source and has not been altered, maintaining the integrity and trustworthiness of the data exchange process.
\nIn the event a webhook request gets an error response from your service, GiddyUp will attempt retries. The retry will attempt to send the same payload from when the error was received.
\nGiddyUp will retry webhook requests when the response from your service is any 4xx or 5xx HTTP response code.
When an error response is retrieved from your service, the retry will be attempted hourly for two days from the original request. The retry requests will come around the 55th minute of each hour.
\nWebhooks will attempt to retry until:
\nA successful response (any http 2xx status code) is received on a retry attempt.
The retry period for the request expires. Currently this is 2 days.
\nEach integration has a unique endpoint path parameter. The correct endpoint for your integration will be displayed in the platform once the integration is complete.
\nThis endpoint is used to update shipment information for a specific order.
\nreference_id (string, required): The order ID shipment information is being added to.
status (string, required): The status of the order's shipment. Can be one of:
shipped
not_shipped (note, the event will be ignored if the status is not_shipped)
canceled
tracking_number (string): The tracking number for the order's shipment
tracking_url (string, optional): The url for the carrier's system containing the tracking number. If provided, this link will be provided to the customer to track their order.
carrier_name (string): The key for the carrier the shipment was shipped with. Can be one of:
DHL eCommerce
DHL_ECOMMERCE
UPS
USPS
usps_first_class_mail
FEDEX
FEDEX2
ups_ground_saver
fastway_au_standard
usps_ground_advantage
firstmile_xparcel_expedited
If the webhook request is successful, the response will have a status of 200 with the following structure:
\n{\n \"Message\": \"Success\"\n}\n\nIf the webhook request is not successful, the response will have a status of 400 with the following structure:
\n{\n \"Message\": \"Fail\",\n \"Error\": {\"type\": \"Error Type\", \"details\": \"...\"}\n}\n\nINVALID_ENDPOINT - The endpoint is not matching the one provided in the platform integrations settings.
\nINVALID_PAYLOAD - The payload fields are not meeting requirements or a shipment was not found with the specified reference_id.
\nRESOURCE_ACCESS_DENIED - The user does not have access to the order.
\nUNEXPECTED_ERROR - The request could not be processed. We suggest you reach out to the support team to initiate an investigation.
\n","urlObject":{"protocol":"https","host":["partner.giddyup.io/api/public/0/webhooks/shipment-update/"],"query":[],"variable":[]}},"response":[{"id":"5d3dab97-0994-4575-a2be-d59c107d0131","name":"Shipment Update","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"reference_id\": \"SAMPLE-12345\",\n \"status\": \"shipped\",\n \"tracking_number\": \"SAMP-3445-3254-2310\",\n \"tracking_url\": \"https://example.com/SAMP-3445-3254-2310\",\n \"carrier_name\": \"FEDEX\"\n}","options":{"raw":{"language":"json"}}},"url":"https://partner.giddyup.io/api/public/0/webhooks/shipment-update/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\"Message\": \"Success\"}"}],"_postman_id":"bed839ae-2b02-4fcc-ba88-d407e7a7c879"}],"id":"fe067f70-076a-4c29-83a6-ecf62a98c32b","description":"This endpoint is used by your application to notify GiddyUp that you have shipped the order.
\nThe request to update the shipment info for an order is sent to a url provided to you in your custom application integration settings page. The webhook URL is provided in the API section of the Settings.
\n","_postman_id":"fe067f70-076a-4c29-83a6-ecf62a98c32b"},{"name":"3PL Fulfillment","item":[{"name":"Order Created","id":"dbf6262e-7651-4640-9fd3-900f2f98264c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-giddyup-hmac-sha256","value":"sha256abc123","description":"HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"order_created\",\n \"order\": {\n \"id\": \"TEST-20818\",\n \"aff_id\": 112211,\n \"customer_first_name\": \"John\",\n \"customer_last_name\": \"Doe\",\n \"shipping_address_line1\": \"200 North Spring Street\",\n \"shipping_address_line2\": null,\n \"shipping_city\": \"Los Angeles\",\n \"shipping_region\": \"CA\",\n \"shipping_country\": \"US\",\n \"shipping_postal_code\": \"90012\",\n \"customer_phone\": \"16501234567\",\n \"customer_email\": \"john.doe@example.com\",\n \"status\": \"placed\",\n \"ordered_at\": \"2024-04-29T19:28:42.531018Z\",\n \"total\": \"115.09\",\n \"discount_total\": \"9.99\",\n \"subtotal\": \"95.97\",\n \"tax\": \"9.12\",\n \"shipping_cost\": \"10.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"items\": [\n {\n \"id\": 36192,\n \"name\": \"Buy 2, Get 1 FREE\",\n \"sku\": null,\n \"quantity\": 1,\n \"price\": \"85.97\",\n \"tax\": \"8.16\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"items\": [\n {\n \"id\": 34473,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34474,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34475,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n }\n ],\n \"tax_details\": [\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"0.86\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"currency\": \"USD\",\n \"vat_inclusive\": false,\n \"currency_format\": {\n \"decimal_mark\": \".\",\n \"thousands_separator\": \",\",\n \"prefix\": \"$\",\n \"suffix\": \"\",\n \"currency_code_suffix\": \"\",\n \"format\": \"$[amount]\"\n },\n \"currency_conversions\": [\n {\n \"currency\": \"USD\",\n \"rate\": \"1.000000000000000\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an order created event payload to the specified webhook URL for order fulfillment. The request body will be in json format and include an event type along with order details such as ID, customer information, shipping details, order status, pricing, items, returns, refunds, currency, VAT information, and currency conversions.
\nevent_type (string): Type of event associated with the order. This will be order_created for an order created event.
order.id (string): Unique identifier for the order.
order.aff_id (int, nullable): Affiliate ID for the order.
order.customer_first_name (string): First name of the customer.
order.customer_last_name (string): Last name of the customer.
order.shipping_address_line1 (string): First line of the shipping address.
order.shipping_address_line2 (string): Second line of the shipping address.
order.shipping_city (string): City for shipping address.
order.shipping_region (string): Region for shipping address.
order.shipping_country (string): Country for shipping address.
order.shipping_postal_code (string): Postal code for shipping address.
order.customer_phone (string): Phone number of the customer.
order.customer_email (string): Email address of the customer.
order.status (string): Status of the order.
order.ordered_at (string): Date and time when the order was placed.
order.total (string): Total amount for the order.
order.discount_total (string): The total amount discounted in the order.
order.subtotal (string): Subtotal amount for the order.
order.tax (string): Tax amount for the order.
order.shipping_cost (string): Shipping cost for the order.
order.shipping_cost_tax (string): Shipping cost tax for the order.
order.items (array): Array of items included in the order, each containing ID, name, sku, quantity, price, tax amount, tax details, sub-items and discounts.
order.discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
order.currency (string): Currency used for the order.
order.vat_inclusive (boolean): Indicates if VAT is inclusive in the pricing.
order.currency_format (object): Format details for the currency including decimal mark, thousands separator, prefix, suffix, currency code suffix, and format.
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
order.currency_conversions (array): Array of currency conversions with currency and rate.
The response to this request can be any value with a success response code (i.e. 2xx)
HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"order_adjusted_line_item\",\n \"order\": {\n \"id\": \"TEST-20818\",\n \"aff_id\": null,\n \"customer_first_name\": \"John\",\n \"customer_last_name\": \"Doe\",\n \"shipping_address_line1\": \"200 North Spring Street\",\n \"shipping_address_line2\": null,\n \"shipping_city\": \"Los Angeles\",\n \"shipping_region\": \"CA\",\n \"shipping_country\": \"US\",\n \"shipping_postal_code\": \"90012\",\n \"customer_phone\": \"16501234567\",\n \"customer_email\": \"john.doe@example.com\",\n \"status\": \"placed\",\n \"ordered_at\": \"2024-04-29T19:28:42.531018Z\",\n \"total\": \"115.09\",\n \"discount_total\": \"9.99\",\n \"subtotal\": \"95.97\",\n \"tax\": \"9.12\",\n \"shipping_cost\": \"10.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"items\": [\n {\n \"id\": 36192,\n \"name\": \"Buy 2, Get 1 FREE\",\n \"sku\": null,\n \"quantity\": 1,\n \"price\": \"85.97\",\n \"tax\": \"8.16\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"items\": [\n {\n \"id\": 34473,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34474,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34475,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n }\n ],\n \"tax_details\": [\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"0.86\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"currency\": \"USD\",\n \"vat_inclusive\": false,\n \"currency_format\": {\n \"decimal_mark\": \".\",\n \"thousands_separator\": \",\",\n \"prefix\": \"$\",\n \"suffix\": \"\",\n \"currency_code_suffix\": \"\",\n \"format\": \"$[amount]\"\n },\n \"currency_conversions\": [\n {\n \"currency\": \"USD\",\n \"rate\": \"1.000000000000000\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an adjusted lined item order payload, which will be the same as other order payloads only some of the item data may have changed. The request body will be in json format and include an event type along with order details such as ID, customer information, shipping details, order status, pricing, items, returns, refunds, currency, VAT information, and currency conversions.
\nevent_type (string): Type of event associated with the order. This will be order_adjusted_line_item for an order created event.
order.id (string): Unique identifier for the order.
order.aff_id (int, nullable): Affiliate ID for the order.
order.customer_first_name (string): First name of the customer.
order.customer_last_name (string): Last name of the customer.
order.shipping_address_line1 (string): First line of the shipping address.
order.shipping_address_line2 (string): Second line of the shipping address.
order.shipping_city (string): City for shipping address.
order.shipping_region (string): Region for shipping address.
order.shipping_country (string): Country for shipping address.
order.shipping_postal_code (string): Postal code for shipping address.
order.customer_phone (string): Phone number of the customer.
order.customer_email (string): Email address of the customer.
order.status (string): Status of the order.
order.ordered_at (string): Date and time when the order was placed.
order.total (string): Total amount for the order.
order.discount_total (string): The total amount discounted in the order.
order.subtotal (string): Subtotal amount for the order.
order.tax (string): Tax amount for the order.
order.shipping_cost (string): Shipping cost for the order.
order.shipping_cost_tax (string): Shipping cost tax for the order.
order.items (array): Array of items included in the order, each containing ID, name, sku, quantity, price, tax amount, tax details, sub-items and discounts.
order.discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
order.currency (string): Currency used for the order.
order.vat_inclusive (boolean): Indicates if VAT is inclusive in the pricing.
order.currency_format (object): Format details for the currency including decimal mark, thousands separator, prefix, suffix, currency code suffix, and format.
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
order.currency_conversions (array): Array of currency conversions with currency and rate.
The response to this request can be any value with a success response code (i.e. 2xx)
HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"test_integration\"\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send a test webhook payload in some circumstances when first connecting the provider. The request body should be empty other than event_type
\nevent_type (string): Type of event associated with webhook. This will be test_integrationThe response to this request can be any value with a success response code (i.e. 2xx)
HMAC sha256 encoded signature of the request body for verification
\n"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"order_updated\",\n \"order\": {\n \"id\": \"TEST-20818\",\n \"aff_id\": 112211,\n \"customer_first_name\": \"John\",\n \"customer_last_name\": \"Doe\",\n \"shipping_address_line1\": \"200 North Spring Street\",\n \"shipping_address_line2\": null,\n \"shipping_city\": \"Los Angeles\",\n \"shipping_region\": \"CA\",\n \"shipping_country\": \"US\",\n \"shipping_postal_code\": \"90012\",\n \"customer_phone\": \"16501234567\",\n \"customer_email\": \"john.doe@example.com\",\n \"status\": \"placed\",\n \"ordered_at\": \"2024-04-29T19:28:42.531018Z\",\n \"total\": \"115.09\",\n \"discount_total\": \"9.99\",\n \"subtotal\": \"95.97\",\n \"tax\": \"9.12\",\n \"shipping_cost\": \"10.00\",\n \"shipping_cost_tax\": \"0.00\",\n \"items\": [\n {\n \"id\": 36192,\n \"name\": \"Buy 2, Get 1 FREE\",\n \"sku\": null,\n \"quantity\": 1,\n \"price\": \"85.97\",\n \"tax\": \"8.16\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"items\": [\n {\n \"id\": 34473,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34474,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n },\n {\n \"id\": 34475,\n \"name\": \"Sample Widget\",\n \"sku\": \"SKU-001\",\n \"quantity\": 1,\n \"price\": \"0.00\",\n \"tax\": \"0.00\",\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"2.65\"\n }\n ]\n }\n ],\n \"tax_details\": [\n {\n \"jurisdiction\": \"CALIFORNIA\",\n \"tax_rate\": \"0.0600\",\n \"tax\": \"5.16\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES\",\n \"tax_rate\": \"0.0025\",\n \"tax\": \"0.21\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES COUNTY DISTRICT TAX SP\",\n \"tax_rate\": \"0.0225\",\n \"tax\": \"1.93\"\n },\n {\n \"jurisdiction\": \"LOS ANGELES CO LOCAL TAX SL\",\n \"tax_rate\": \"0.0100\",\n \"tax\": \"0.86\"\n }\n ]\n }\n ],\n \"discounts\": [\n {\n \"code\": \"SUMMER25\",\n \"amount\": \"9.99\"\n }\n ],\n \"currency\": \"USD\",\n \"vat_inclusive\": false,\n \"currency_format\": {\n \"decimal_mark\": \".\",\n \"thousands_separator\": \",\",\n \"prefix\": \"$\",\n \"suffix\": \"\",\n \"currency_code_suffix\": \"\",\n \"format\": \"$[amount]\"\n },\n \"currency_conversions\": [\n {\n \"currency\": \"USD\",\n \"rate\": \"1.000000000000000\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an order updated event payload to the specified webhook URL for order fulfillment updates. The request body will be in json format and include an event type along with order details such as ID, customer information, shipping details, order status, pricing, items, returns, refunds, currency, VAT information, and currency conversions.
\nevent_type (string): Type of event associated with the order. This will be order_created for an order created event.
order.id (string): Unique identifier for the order.
order.customer_first_name (string): First name of the customer.
order.customer_last_name (string): Last name of the customer.
order.shipping_address_line1 (string): First line of the shipping address.
order.shipping_address_line2 (string): Second line of the shipping address.
order.shipping_city (string): City for shipping address.
order.shipping_region (string): Region for shipping address.
order.shipping_country (string): Country for shipping address.
order.shipping_postal_code (string): Postal code for shipping address.
order.customer_phone (string): Phone number of the customer.
order.customer_email (string): Email address of the customer.
order.status (string): Status of the order.
order.ordered_at (string): Date and time when the order was placed.
order.total (string): Total amount for the order.
order.discount_total (string): The total amount discounted in the order.
order.subtotal (string): Subtotal amount for the order.
order.tax (string): Tax amount for the order.
order.shipping_cost (string): Shipping cost for the order.
order.shipping_cost_tax (string): Shipping cost tax for the order.
order.items (array): Array of items included in the order, each containing ID, name, sku, quantity, price, tax amount, tax details, sub-items and discounts.
order.discounts (array): An array of objects containing details of discounts applied on the order including amount and code.
order.currency (string): Currency used for the order.
order.vat_inclusive (boolean): Indicates if VAT is inclusive in the pricing.
order.currency_format (object): Format details for the currency including decimal mark, thousands separator, prefix, suffix, currency code suffix, and format.
decimal_mark (string): The character used as the decimal mark for the currency.
thousands_separator (string): The character used to separate thousands for the currency.
prefix (string): The symbol (if applicable) that comes before the amount.
suffix (string): The symbol (if applicable) that comes after the amount.
currency_code_suffix (string): The currency code to add to the end of the formatted string if applicable. This is used in cases where the currency symbol may not make it clear which currency is being used, like $10 CAD.
format (string): The final format for the currency including prefixes and suffixes.
order.currency_conversions (array): Array of currency conversions with currency and rate.
The response to this request can be any value with a success response code (i.e. 2xx)
HMAC sha256 encoded signature of the request body for verification
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_type\": \"cancel_shipment\",\n \"order_id\": \"TEST-20825\"\n}","options":{"raw":{"language":"json"}}},"url":"https://example.com/webhook","description":"This HTTP POST request is used to send an cancel shipment event payload to the specified webhook URL when order is cancelled. The request body will be in json format and include an event type along with order ID.
\nevent_type (string): Type of event associated with the order. This will be cancel_shipment for an order cancelled event.order_id (string): Unique identifier for the order that was cancelled.The response to this request can be any value with a success response code (i.e. 2xx)
Custom integration can be used as external 3PL for fulfillment (instead of using a standard fulfillment integration). GiddyUp platform will send order fulfillment details to the webhook URL in custom integration if 3PL fulfillment is enabled.
\n","_postman_id":"e544e52f-8aa7-41dd-8c2b-f137e8cda94e"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"7266c50c-ac80-43dd-a797-b1693c7cb038"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3f5b1ed0-0de1-4c24-98d1-4aaf4e23f8f5"}}],"variable":[{"key":"token","value":"sample0token1value2","type":"string"},{"key":"order_id","value":"SAMPLE-12345","type":"string"},{"key":"your_webhook_url","value":"example.com/webhook","type":"string"},{"key":"gu_host","value":"partner.giddyup.io","type":"string"},{"key":"gu_webook_url","value":"partner.giddyup.io/api/public/0/webhooks/shipment-update/","type":"string"},{"key":"brand_id","value":"0","type":"string"}]}