Anchor to orderEditUpdateShippingLineorder
orderEditUpdateShippingLine
mutation
Requires access scope.
Updates a shipping line on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
Anchor to Arguments
Arguments
- •ID!required
The ID of the calculated order from which to update the shipping line.
- Anchor to shippingLineshipping•
Line The updated shipping line.
- Anchor to shippingLineIdshipping•
Line Id ID!required The ID of the calculated shipping line to update.
Was this section helpful?
Anchor to OrderEditUpdateShippingLinePayload returnsOrderEditUpdateShippingLinePayload returns
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Was this section helpful?
- Get a user error when updating a committed shipping line
- Update a staged shipping line on an order edit
- orderEditUpdateShippingLine reference
Examples
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {
orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {
calculatedOrder {
id
totalOutstandingSet {
presentmentMoney {
amount
currencyCode
}
}
totalPriceSet {
presentmentMoney {
amount
currencyCode
}
}
}
userErrors {
field
message
mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {
orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {
calculatedOrder {
id
totalOutstandingSet {
presentmentMoney {
amount
currencyCode
}
}
totalPriceSet {
presentmentMoney {
amount
currencyCode
}
}
}
userErrors {
field
message
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) { orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) { calculatedOrder { id totalOutstandingSet { presentmentMoney { amount currencyCode } } totalPriceSet { presentmentMoney { amount currencyCode } } } userErrors { field message } } }",
"variables": {
"id": "gid://shopify/CalculatedOrder/607673082",
"shippingLineId": "gid://shopify/ShippingLine/1072813969",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {
orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {
calculatedOrder {
id
totalOutstandingSet {
presentmentMoney {
amount
currencyCode
}
}
totalPriceSet {
presentmentMoney {
amount
currencyCode
}
}
}
userErrors {
field
message
}
}
}`,
{
variables: {
"id": "gid://shopify/CalculatedOrder/607673082",
"shippingLineId": "gid://shopify/ShippingLine/1072813969",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {
orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {
calculatedOrder {
id
totalOutstandingSet {
presentmentMoney {
amount
currencyCode
}
}
totalPriceSet {
presentmentMoney {
amount
currencyCode
}
}
}
userErrors {
field
message
}
}
}`,
"variables": {
"id": "gid://shopify/CalculatedOrder/607673082",
"shippingLineId": "gid://shopify/ShippingLine/1072813969",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
},
},
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {
orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {
calculatedOrder {
id
totalOutstandingSet {
presentmentMoney {
amount
currencyCode
}
}
totalPriceSet {
presentmentMoney {
amount
currencyCode
}
}
}
userErrors {
field
message
}
}
}
QUERY
variables = {
"id": "gid://shopify/CalculatedOrder/607673082",
"shippingLineId": "gid://shopify/ShippingLine/1072813969",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
}
response = client.query(query: query, variables: variables)
Input variables
JSON{
"id": "gid://shopify/CalculatedOrder/607673082",
"shippingLineId": "gid://shopify/ShippingLine/1072813969",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
}
Response
JSON{
"orderEditUpdateShippingLine": null
}