Orders
Archive Order
Archive an order
Archives an order, removing it from the default order list views. Archived orders can still be accessed and unarchived later.
Authorization
api_key x-access-token<token>
In: header
Path Parameters
order_id*string
The ID of the order to archive
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/shipos/orders/string/archive"{ "id": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "closed_at": "2019-08-24T14:15:22Z", "cancelled_at": "2019-08-24T14:15:22Z", "remote_id": "string", "synced_at": "2019-08-24T14:15:22Z", "merchant_team_id": "string", "team_id": "string", "shop_id": "string", "shop_name": "string", "shop_slug": "string", "shop_type": "SHOPIFY", "fulfillment_status": "FULFILLED", "payment_status": "PENDING", "priority": "LOW", "order_number": "string", "currency": "string", "note": "string", "metadata": { "custom": [ { "key": "string", "value": "string" } ], "shopify": [ { "key": "string", "value": "string" } ], "woo": [ { "key": "string", "value": "string" } ], "bigcommerce": [ { "key": "string", "value": "string" } ] }, "shipping_method": "string", "deliver_by": "2019-08-24T14:15:22Z", "line_item_hash": "string", "tags": [ "string" ], "total_price": 0.1, "total_tax": 0.1, "total_discount": 0.1, "total_shipping": 0.1, "current_shipping": 0.1, "total_outstanding": 0.1, "shipping_address_name": "string", "shipping_address_company": "string", "shipping_address_address1": "string", "shipping_address_address2": "string", "shipping_address_city": "string", "shipping_address_state": "string", "shipping_address_country": "string", "shipping_address_zip": "string", "shipping_address_phone": "string", "shipping_latitude": 0, "shipping_longitude": 0, "billing_address_name": "string", "billing_address_company": "string", "billing_address_address1": "string", "billing_address_address2": "string", "billing_address_city": "string", "billing_address_state": "string", "billing_address_country": "string", "billing_address_zip": "string", "billing_address_phone": "string", "customer_email": "string", "customer_name": "string", "customer_phone": "string", "carton_id": "string", "carton_name": "string", "carrier_integration_id": "string", "carrier_integration_type": "GENERIC", "carrier_integration_name": "string", "carrier_id": "string", "service_id": "string", "rate_shop_name": "string", "formatted_service": "string", "status": "OPEN", "merchant_team_name": "string", "team_name": "string", "fulfiller_team_id": "string", "fulfiller_team_name": "string", "lock_address": true, "address_verified": true, "address_residential": "RESIDENTIAL", "address_verification_response": { "metadata": { "is_active": true, "is_cmra": true, "is_vacant": true, "record_type": "S", "dpv_footnotes": "string", "dpv_match_code": "Y", "longitude": 0, "latitude": 0 }, "errors": [ { "message": "string", "code": "string" } ], "corrected_address": { "zip4": "string", "zip5": "string", "state": "string", "city": "string", "street2": "string", "street1": "string" }, "residential": "RESIDENTIAL", "verified": true }, "address_verified_at": "2019-08-24T14:15:22Z", "address_hash": "string", "is_fragile": true, "core_line_item_count": 0.1, "unique_core_line_item_count": 0.1, "tracking_count": 0.1, "fulfillment_count": 0.1, "line_item_image_urls": [ "string" ], "config": { "require_pack_shot": true, "show_unfulfilled_items_on_packing_list": true, "show_prices_on_packing_slip": true, "tote_qa_enabled": true, "address_verification_enabled": true, "incoterm": "FAS", "incoterm_location": "string", "eel_pfc": "string", "delivery_confirmation": "NO_SIGNATURE", "saturday_delivery": true, "insurance_policy": { "mode": "none" }, "customs_signer": "string", "customs_signer_title": "string", "customs_certify": true, "non_delivery_option": "ABANDON", "restriction_type": "NONE", "restriction_comments": "string", "contents_type": "OTHER", "contents_explanation": "string", "commercial_invoice_transaction_reason": "SALE", "declaration": "string", "commercial_invoice_payment_terms": "string", "commercial_invoice_transport_mode": "string", "commercial_invoice_port_of_entry": "string", "commercial_invoice_country_of_transshipment": "string", "commercial_invoice_package_marks": "string", "commercial_invoice_freight_amount": 0, "commercial_invoice_discount_amount": 0, "commercial_invoice_other_charge_amount": 0, "commercial_invoice_other_charge_description": "string", "commercial_invoice_importer_tax_id": "string", "commercial_invoice_importer_vat": "string", "commercial_invoice_importer_eori": "string", "commercial_invoice_importer_ioss": "string", "commercial_invoice_vat_statement": "string", "commercial_invoice_export_license_number": "string", "destination_control_statement_required": true }, "order_fulfillment_holds": [ { "active": true, "order_id": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "created_by_user_id": "string", "reason_notes": "string", "reason": "AWAITING_PAYMENT", "id": "string" } ], "package_preset_id": "string", "package_preset_name": "string"}