UpdateShippingOrder
Update a shipping order
Parameters
| id - ID |
|---|
| Id of the shipping order |
| input - ShippingOrderInput |
|---|
| Data of the shipping order |
Example
mutation UpdateShippingOrder($id: ID!, $input: ShippingOrderInput!) {
UpdateShippingOrder(id: $id, input: $input) {
id
label
dated_at
status
total_units
notes
shipped
shipping_at
order {
id
label
dated_at
status
total_units
notes
customer {
id
label
}
}
shipping_address {
id
label
country
address_1
address_2
postal_code
city
state
phone
}
line_items {
id
parent_id
kit_line_item_id
is_kit
description
quantity
on_hand
weight
location {
id
label
}
variant {
id
sku
label
type
product {
id
}
}
}
integrations {
id
provider
data
}
}
}
{
"id": 100004,
"input": {
"id": 100004,
"label": "SHO00000005",
"notes": "7Q3mRLFgHZ",
"total_units": 39502840.8767547,
"status": "pending",
"dated_at": "1970-08-21",
"shipping_at": "2004-01-15",
"shipping_address": {
"id": 100048,
"label": "G8vwZUY2Ci",
"country": "TR",
"address_1": "83068 Effertz Springs Apt. 376",
"address_2": "Apt. 899",
"postal_code": "35104-5042",
"city": "Port Grayson",
"state": null,
"phone": "+1 (947) 841-8042"
},
"line_items": [
{
"id": 100070,
"temporary_id": 100070,
"is_kit": false,
"quantity": 39490731.0225718,
"weight": 0,
"parent_id": 100026,
"description": null,
"location": {
"id": 100000,
"label": "Default location"
},
"variant": {
"id": 100221,
"label": "Formidable Asics Coat"
}
},
{
"id": 100071,
"temporary_id": 100071,
"is_kit": false,
"quantity": 11943.9388125,
"weight": 1,
"parent_id": 100027,
"description": null,
"location": {
"id": 100000,
"label": "Default location"
},
"variant": {
"id": 100222,
"label": "Stunning Hummel Jacket"
}
},
{
"id": 100072,
"temporary_id": 100072,
"is_kit": false,
"quantity": 165,
"weight": 2,
"parent_id": 100028,
"description": null,
"location": {
"id": 100000,
"label": "Default location"
},
"variant": {
"id": 100223,
"label": "Super Puma Sneakers"
},
"batch_numbers":[
{
"batch_number":{
"id":189000
},
"quantity":160
},
{
"batch_number":{
"id":189666
},
"quantity":5
}
]
}
]
}
}
Returned data
{
"data": {
"UpdateShippingOrder": {
"id": 100004,
"label": "SHO00000005",
"dated_at": "1970-08-21",
"status": "pending",
"total_units": 39502840.8767547,
"notes": "7Q3mRLFgHZ",
"shipped": null,
"shipping_at": "2004-01-15",
"order": {
"id": 100005,
"label": "O00000006",
"dated_at": "1970-08-21",
"status": "active",
"total_units": 125181819.3435115,
"notes": "7Q3mRLFgHZ",
"customer": {
"id": 100000,
"label": "Daniel"
}
},
"shipping_address": {
"id": 100048,
"label": "G8vwZUY2Ci",
"country": "TR",
"address_1": "83068 Effertz Springs Apt. 376",
"address_2": "Apt. 899",
"postal_code": "35104-5042",
"city": "Port Grayson",
"state": null,
"phone": "+1 (947) 841-8042"
},
"line_items": [
{
"id": 100070,
"parent_id": 100026,
"kit_line_item_id": null,
"is_kit": false,
"description": null,
"quantity": 39490731.0225718,
"on_hand": null,
"weight": 0,
"location": {
"id": 100000,
"label": "Default location"
},
"variant": {
"id": 100221,
"sku": "6ap5A7qGAp",
"label": "Formidable Asics Coat",
"type": "normal",
"product": {
"id": 100181
}
},
"batch_numbers":[]
},
{
"id": 100071,
"parent_id": 100027,
"kit_line_item_id": null,
"is_kit": false,
"description": null,
"quantity": 11943.9388125,
"on_hand": null,
"weight": 1,
"location": {
"id": 100000,
"label": "Default location"
},
"variant": {
"id": 100222,
"sku": "bpKogif117",
"label": "Stunning Hummel Jacket",
"type": "normal",
"product": {
"id": 100182
}
},
"batch_numbers":[]
},
{
"id": 100072,
"parent_id": 100028,
"kit_line_item_id": null,
"is_kit": false,
"description": null,
"quantity": 165.9153704,
"on_hand": null,
"weight": 2,
"location": {
"id": 100000,
"label": "Default location"
},
"variant": {
"id": 100223,
"sku": "39zKtp4CjK",
"label": "Super Puma Sneakers",
"type": "normal",
"product": {
"id": 100183
}
},
"batch_numbers":[
{
"batch_number":{
"id":189000
},
"quantity":160
},
{
"batch_number":{
"id":189666
},
"quantity":5
}
]
}
],
"integrations": []
}
}
}
DeleteShippingOrder
Delete a shipping order
Parameters
| id - ID |
|---|
| Id of the shipping order |
Example
mutation DeleteShippingOrder($id: ID!) {
DeleteShippingOrder(id: $id)
}
{
"id": 100009
}
Returned data
{
"data": {
"DeleteShippingOrder": true
}
}
ShippingOrderInput data type
| id - Int |
|---|
| Unique identifier of the shipping order |
| label - String |
|---|
| Title of the shipping order |
| notes - String |
|---|
| Notes attached to the shipping order |
| total_units - Float |
|---|
| Total units of the shipping order |
| status - Enum |
|---|
| Status of the shipping order (enum values : pending, unpublished, make_the_shipment, in_preparation, ready_to_ship, shipped, delivered, cancelled). |
| dated_at - Date |
|---|
| Date of the order. |
| shipping_address - AddressInput - Subquery |
|---|
| Shipping address of the order. |
| shipping_at - Date |
|---|
| Date the shipping is planned. |
| line_items - Array of LineItemInput - Subquery |
|---|
| List of the line items of the shipping order |